Implementing Context Sensitive help

As a Visual Basic developer, you will appreciate how convenient it is to be able to press F1 whilst your cursor is over a Method or property or Object you are attempting to use and to have the relevant Help file and topic appear.  Document! VB allows you to implement that level of Help support in your software without you having to lift a finger.

Creating a fully context sensitive project is a 3 stage process :

  1. When you are ready to create your help file and compiled software, invoke the Document! VB wizard and select 'Create context sensitive links' in Stage 4 of the Document! VB wizard.  This will create a seperate copy of your source code containing the required context sensitive help id numbers and create the required links in your generated help file;
  2. Compile the seperate copy of your source code (which contains the required Help IDs and Help file name);
  3. Ship the created HTML Help file with your compiled software, ensuring that your Help file is installed in either a) the <Windows>\Help directory, the <Windows>\System32 directory or your softwares install directory.

Important If you are shipping your component for use by Visual Basic 5 users, please read the 'Context Sensitive HTML Help and Visual Basic Version 5' topic.

It really is as simple as that.  Now your customers / users will have instant access to the Help they need.